Skip to content

Add PR description generator skill with comprehensive documentation a…#219

Open
nurfarazi wants to merge 2 commits intovercel-labs:mainfrom
nurfarazi:add-pr-description-generator-skill
Open

Add PR description generator skill with comprehensive documentation a…#219
nurfarazi wants to merge 2 commits intovercel-labs:mainfrom
nurfarazi:add-pr-description-generator-skill

Conversation

@nurfarazi
Copy link
Copy Markdown

@nurfarazi nurfarazi commented Apr 6, 2026

Issue / Context

Linked issue: N/A

Problem being solved:
This PR adds a dedicated skill for generating reviewer-friendly PR descriptions. Before this change, there wasn’t a canonical, reusable workflow in the skills repo for gathering diff context, commit history, impacted areas, and test signals before drafting a PR summary. The new skill gives agents a structured way to turn a code change into a clear, review-ready description instead of relying on ad hoc summaries.


Why This Matters

This skill turns PR writing from an improvised, variable-quality step into a repeatable workflow that reviewers can trust.

  • Faster reviews: contributors get a structured summary up front, so reviewers spend less time reconstructing intent from the diff.
  • Better decisions: the description calls out impacted areas, data flow, and testing signals, which makes risk easier to spot.
  • Consistent documentation: every PR written with this skill follows the same shape, which keeps repository conventions predictable and easier to maintain.

What Changed

Impacted Areas

Area Files Nature of Change
Skill documentation skills/pr-description-generator/SKILL.md Added the skill workflow, guidance, and output expectations
Supporting templates skills/pr-description-generator/references/pr-template.md Added a reusable PR description template with required sections
Scoring guidance skills/pr-description-generator/references/scoring-rubric.md Added rubric details for code quality, architecture, and test coverage
Skill metadata skills/pr-description-generator/metadata.json Added package metadata and references
Repository index README.md Added the new skill to the skills catalog
Packaged artifact skills/pr-description-generator.zip Added the distributable skill bundle

Data Flow

Before:

User asks for a PR description
→ No dedicated skill workflow
→ Manual summarization or one-off prompt
→ Output quality varies by reviewer and context

After:

User asks for a PR description
→ Skill gathers diff, commits, linked issue, and test files
→ Skill analyzes impacted areas, data flow, and risk surface
→ Skill applies scoring rubric
→ Skill populates the PR template with a structured review-ready description

Scores

Dimension Score Rationale
Code Quality 9/10 The docs are clear, consistent, and well-structured, with a focused separation between workflow, template, and rubric.
Architecture 9/10 The skill is modular and easy to maintain: behavior, template, and scoring guidance are split into separate files and referenced cleanly.
Test Coverage 1/10 This PR adds documentation and configuration only; there are no automated tests or validation checks in the change set.

Testing Scenarios

List the scenarios a reviewer or QA should verify:

  • The new pr-description-generator entry appears in README.md and is easy to discover.
  • skills/pr-description-generator/SKILL.md clearly instructs the agent to gather diff, commit, issue, and test context before writing.
  • references/pr-template.md includes all required sections and no placeholder text is left in the committed template.
  • references/scoring-rubric.md provides clear, usable guidance for 1-10 scoring across the three dimensions.
  • The packaged skills/pr-description-generator.zip contains the new skill content for distribution.

Suggestions (Out of Scope)

Improvements noticed during this review that are not part of this PR:

Priority Location Suggestion
Medium skills/pr-description-generator/SKILL.md Add a short example of a completed PR description so users can see the expected output shape at a glance.
Low README.md Consider linking the new skill entry directly to its folder or docs so readers can jump to implementation details faster.
Low references/pr-template.md Consider an optional "Risks / Rollout" section for code changes that affect runtime behavior, so the template can scale beyond docs-only updates.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 6, 2026

@nurfarazi is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

@nurfarazi nurfarazi force-pushed the add-pr-description-generator-skill branch from b4edf21 to 6a5bd04 Compare April 11, 2026 06:59
Comment thread .env Outdated
Comment thread packages/react-best-practices-build/src/build.ts
@nurfarazi nurfarazi force-pushed the add-pr-description-generator-skill branch from 6a5bd04 to b4edf21 Compare April 11, 2026 15:07
@nurfarazi nurfarazi force-pushed the add-pr-description-generator-skill branch from 7fedf0c to c4f440e Compare May 6, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant